Skip to content

docs: update README to reflect supported maintenance version#104

Merged
jackwotherspoon merged 4 commits intogoogleapis:mainfrom
juliaofferman:patch-1
Dec 20, 2024
Merged

docs: update README to reflect supported maintenance version#104
jackwotherspoon merged 4 commits intogoogleapis:mainfrom
juliaofferman:patch-1

Conversation

@juliaofferman
Copy link
Contributor

@juliaofferman juliaofferman commented Dec 19, 2024

MySQL vector syntax has changed in the latest maintenance version (see https://cloud.google.com/sql/docs/mysql/work-with-vectors). We are yet to update the integration to use this new syntax, so need to call out the supported versions while we work on a new version of the integration. The updated syntax includes changing the ANN search function name, parameters, and where it can appear in a query. Additionally, create/drop/alter vector index syntax has changed. There are also some new restrictions, ie a table must have 1000 rows before creating an index.

MySQL vector syntax has changed in the latest maintenance version (see https://cloud.google.com/sql/docs/mysql/work-with-vectors). We are yet to update the integration to use this new syntax, so need to call out the supported versions while we work on a new version of the integration.
@juliaofferman juliaofferman requested review from a team as code owners December 19, 2024 01:05
@product-auto-label product-auto-label bot added the api: cloudsql-mysql Issues related to the googleapis/langchain-google-cloud-sql-mysql-python API. label Dec 19, 2024
@jackwotherspoon
Copy link
Contributor

/gcbrun

@jackwotherspoon jackwotherspoon changed the title Update doc to reflect supported maintenance version docs: update README to reflect supported maintenance version Dec 19, 2024
@jackwotherspoon
Copy link
Contributor

@juliaofferman do you mind adding to the PR description some details highlighting what the syntax changes are?

Copy link
Collaborator

@averikitsch averikitsch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@averikitsch
Copy link
Collaborator

/gcbrun

Copy link
Contributor

@jackwotherspoon jackwotherspoon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, ditto Averi's comment of adding a note to README.

Also see my other comment about updating description to give more details into what the differences in syntax are now.

Add note that maintenance versions between
MYSQL_8_0_36.R20240401.03_00 and
MYSQL_8_0_36.R20241208.01_00 are required to the
overall README and vector_store notebook.
@jackwotherspoon
Copy link
Contributor

/gcbrun

Underline was shorter than the section heading, causing "sphinx.errors.SphinxWarning: /home/runner/work/langchain-google-cloud-sql-mysql-python/langchain-google-cloud-sql-mysql-python/docs/README.rst:35:Title underline too short.". Fixed the underline to match text
@juliaofferman
Copy link
Contributor Author

/gcbrun

1 similar comment
@jackwotherspoon
Copy link
Contributor

/gcbrun

@jackwotherspoon jackwotherspoon merged commit 3ac0aab into googleapis:main Dec 20, 2024
10 checks passed
juliaofferman added a commit to juliaofferman/genai-databases-retrieval-app-mysql that referenced this pull request Feb 27, 2025
Yuan325 added a commit to GoogleCloudPlatform/cymbal-air-toolbox-demo that referenced this pull request Feb 28, 2025
…ported maintenance versions (#529)

Updated integration with this:


googleapis/langchain-google-cloud-sql-mysql-python#104

but have not yet updated the sample app.

---------

Co-authored-by: Yuan <45984206+Yuan325@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

api: cloudsql-mysql Issues related to the googleapis/langchain-google-cloud-sql-mysql-python API.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants